/**
 * Copyright (c) <2010>, <SUNNY GUPTA>
 * All rights reserved.

 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *   * Neither the name of the <ORGANIZATION> nor the
 *     names of its contributors may be used to endorse or promote products
 *     derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL <SUNNY GUPTA> BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package com.gwtp.investmentadvisor.server.entities.finance;

import javax.persistence.Id;
import javax.persistence.Transient;

import com.googlecode.objectify.Key;
import com.gwtp.investmentadvisor.server.entities.general.Country;

/**
 * @author Sunny Gupta
 *
 */
public class FinancialMarket {
  private static final String DEFAULT_MARKET_NAME = "National Stock Exchange of India";
  private static final String DEFAULT_MARKET_IDENTIFIER = "INDIA.NSE";

  public FinancialMarket() {
    // Initialize defaults
    Country country = new Country();
    setCountryKey(country.getKey());
    setName(DEFAULT_MARKET_NAME);
    setMarketID(DEFAULT_MARKET_IDENTIFIER);
    setUniqueIdentifier();
  }
  
  /**
   * Market Name.
   */
  private String name;
  
  /**
   * Country.
   */
  private Key<Country> countryKey;
  
  /**
   * Market Identifier.
   */
  private String marketID;
  
  /**
   * Unique Identifier for persistence.
   */
  @Id
  private String uniqueIdentifier;

  /**
   * @param country the country to set
   */
  public void setCountryKey(Key<Country> countryKey) {
    // Only if different
    if (!this.countryKey.equals(countryKey)) {
      this.countryKey = countryKey;
      setUniqueIdentifier();
    }
  }
  /**
   * @return the country
   */
  public Key<Country> getCountryKey() {
    return this.countryKey;
  }
  
  /**
   * @param name the name to set
   */
  public void setName(String name) {
    // Only if different
    if (!this.name.equals(name)) {
      this.name = name;
      setUniqueIdentifier();
    }
  }

  /**
   * @return the name
   */
  public String getName() {
    return name;
  }

  public void setMarketID(String identifier) {
    // Only if different
    if (!this.marketID.equals(identifier)) {
      this.marketID = identifier;
      setUniqueIdentifier();
    }
  }

  public String getMarketID() {
    return marketID;
  }

  private void setUniqueIdentifier() {
    // Country_MarketID
    this.uniqueIdentifier = this.countryKey.getName() + "_" + this.marketID;
    this.key = new Key<FinancialMarket>(FinancialMarket.class, this.uniqueIdentifier);
  }

  public String getUniqueIdentifier() {
    return uniqueIdentifier;
  }
  
  /**
   * Need not be stored, but may be required by clients.
   */
  @Transient
  private Key<FinancialMarket> key;
  
  public Key<FinancialMarket> getKey() {
    return key;
  }
}
